fix(container): add caution #9582
Conversation
ematipico
added
the
improve documentation
✅ Deploy Preview for astro-docs-2 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
| :::caution | ||
| Outside `vite` or for on-demand usage, you'll have to [load the renderers manually](#adding-a-renderer-manually). | ||
| ::: |
There was a problem hiding this comment.
| :::caution | |
| Outside `vite` or for on-demand usage, you'll have to [load the renderers manually](#adding-a-renderer-manually). | |
| ::: | |
| Outside `vite` or for on-demand usage, you'll have to [load the renderers manually](#adding-a-renderer-manually). |
Let's try without the big caution first, as this isn't like a security warning or anything, and see if just having it written explicitly here before the example is enough! If you still find people are struggling with this, then we can look at making it more visible!
There was a problem hiding this comment.
I'm not really sure. Currently, we already have this phrase in production, and I still get users that use the container API incorrectly. :/
There was a problem hiding this comment.
Seems like a great addition @ematipico ! My preference is always to avoid notes etc. for content that is essential, like this is. So I left a suggestion to try without a big flaming caution first, to see whether that's enough.
But the content is great!
Description (required)
More than once users were incorrectly using the containers API, I figured that adding a
cautionblock could help user to understand which API to use, and when.